home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / apps / other / st_diary.lzh / MANUAL.DOC < prev    next >
Text File  |  1993-01-26  |  27KB  |  639 lines
  1.                               ST Diary V1.0
  2.                               -------------
  3.  
  4. Introduction
  5. ------------
  6.  
  7. ST Diary as the name suggests is an electronic version  of a  page  a  day 
  8. diary. Unlike conventional diaries, ST Diary will continue to function for
  9. more that one year and will automatically adjust for leap years.
  10.  
  11. The 'Day I' and 'Day II' pulldown menu columns refer to the left and right 
  12. hand  sides of the screen respectively.  When a file is either  opened  or 
  13. created then a graphical representation of an open diary will be displayed 
  14. on the screen. The two 'Day' columns have identical commands to access and 
  15. process the data stored in the  diary.  ST Diary  only  deals  with  whole
  16. years, one year per file.  If all lines on every day is packed  with  text
  17. then a one megabyte machine will be needed.  With files  of  this  size  a
  18. standard double density floppy disc will hold two complete years (files).
  19.  
  20. Each page is laid out like a conventional diary. In normal sized text next 
  21. to the edge of the page is the day,  the position within the month and the 
  22. current month.
  23.  
  24. Example : Sunday 26 January
  25.  
  26. In small text near the centre of the screen there is the week number,  the 
  27. number  of  the current day within the year and the number  of  days  left 
  28. to go in the year.
  29.  
  30. Example : Week 4
  31.           26 - 340
  32.  
  33.  
  34. ST Diary's Features :
  35.  
  36.                       * Page a day diary
  37.                       * Annual event storage
  38.                       * Calendar
  39.                       * 8 page note pad
  40.  
  41. The eight page note pad can be found at the end of  the  diary.  Press the 
  42. right arrow keys to move towards the end of the year and into the note pad 
  43. section. Use the standard 'Day I' and 'Day II' commands to manipulate data 
  44. in the note pad. Notes are automatically saved when the diary is saved.
  45.  
  46.  
  47.  
  48. Hardware / Software Platform
  49. ----------------------------
  50.  
  51. Computer     : Atari 680x0 computer
  52. Memory       : 1 Mb
  53. Graphics     : 640 x 400 x 2 colors (E.G. SM125, 124 or 144 monitors)
  54. Peripherals  : Mouse
  55.                External floppy 'B' and hard discs supported (Hard disc
  56.                recommeded for multiple years).
  57.                Printer - Epson Mode (Necessary for printer commands only)
  58.  
  59. If  a  TV or colour monitor is to be used then a mono  emulator  piece  of 
  60. software should be run before hand.
  61.  
  62.  
  63.  
  64. Software Installation
  65. ---------------------
  66.  
  67. There should be the following four files on the supplied disk :
  68.  
  69. ST_DIARY.PRG - ST Diary program.
  70. CONVERT.PRG  - Conversion program for EVENT.DAT files.
  71. ST_DIARY.HLP - ST Diary On-Line help file.
  72. EVENTS.DAT   - ST Diary events file.
  73.  
  74.  
  75. ST_DIARY.PRG :
  76.  
  77. This is the program which may be run from the Desktop,  or installed as an 
  78. accessory  to  automatically  load  in  diary  files.  The  program  file, 
  79. ST_DIARY.HLP  and  EVENTS.DAT files must all reside in the same  folder  / 
  80. drive, but the data files (diary years) may be in any folder or drive.
  81.  
  82.  
  83. CONVERT.PRG :
  84.  
  85. This  program  converts  leap year event data  files  into  non-leap  year 
  86. conpatible files and visa versa.  Events are stored in the file  according 
  87. to their position in the year (1 to 365) but, in a leap year there are 366 
  88. days in a year.  The extra day (29 February) has the effect of pushing all 
  89. events after the 29 of February out one day.
  90.  
  91. To  fix this problem just run CONVERT.PRG from the desktop.  An Alert  box 
  92. will be displayed with the following options :
  93.  
  94. Leap   : Converts a normal file into a leap year conpatible file. If there 
  95.          is  an event in day 366 then it will be positioned on the  29  of 
  96.          February.  All days after the 28 of February are moved along  one 
  97.          position in the file.
  98.  
  99. Normal : Converts a leap year file into a non-leap year  conpatable  file. 
  100.          Takes  the  29  of  February and places it  at  the  end  of  the 
  101.          EVENTS.DAT file (day 366).  This is so that any event on this day 
  102.          can be converted back in  four  years  time  without  losing  any 
  103.          data.
  104.  
  105. Quit   : Terminates program and returns back to the Desktop.
  106.  
  107.  
  108. NOTE  :  The  'Leap' and 'Normal' options specify the format  of  the  new 
  109. converted file, NOT the format of the old file.
  110.  
  111.  
  112.  
  113. ST_DIARY.HLP :
  114.  
  115. This is the file that contains the On-Line help file for ST Diary.  It  is 
  116. standard  ASCII  in format and so may be edited by a  word  processor.  It 
  117. should be noted that any alterations are for the use of the user that made 
  118. the alterations only. If altered files are passed on to any other users of 
  119. ST Diary then this will constitute a breach of copyright.
  120.  
  121. The  help file has key words in upper case which relates directly  to  the 
  122. help menu buttons. ST Diary reads all text between these key words and the 
  123. data end commands 'END'. Extra data may therefore be inserted between the 
  124. relevant key word and an END.
  125.  
  126. If  the file ST_DIARY.HLP is not found in the same folder as  ST_DIARY.PRG 
  127. then a warning message will be displayed.
  128.  
  129.  
  130. EVENTS.DAT :
  131.  
  132. This  is the events data file that is loaded when ST Diary is  first  run. 
  133. This file is not compulsory but is necessary to store events  information. 
  134. There is only one events file because it is designed to store events  that 
  135. happen  each year on the same day.  To update this events file,  edit  the 
  136. relevant  event(s)  and then use the SAVE EVENTS command  under  the  FILE 
  137. pulldown  menu column,  this will save all 365 or 366 events to  the  file 
  138. EVENTS.DAT.
  139.  
  140. See CONVERT.PRG.
  141.  
  142.  
  143.  
  144. Disclaimer
  145. ----------
  146.  
  147. Wilkinson  Enterprises  may not be held responsible for any  software  or 
  148. hardware  errors  that  occur  through  the  use,   either  directly   or 
  149. indirectly, of ST Diary.
  150.  
  151.  
  152. Commands
  153. --------
  154.  
  155. The next part of the manual (Atari Symbol to Extras) explains the  meaning 
  156. and use of all ST Diary's commands. The commands are in order according to 
  157. the  pulldown menu interface,  starting on the left and working down  each 
  158. menu column in turn.
  159.  
  160.  
  161. Atari Symbol
  162. ------------
  163.  
  164. This is the credits screen which displays information on the following :
  165.  
  166.                    Author
  167.                    Software Name and Version number
  168.                    Copyright Date
  169.                    Language used in construction of software
  170.  
  171.  
  172. Any accessories present will be displayed below the  ST Diary  Information
  173. menu option.
  174.  
  175.  
  176. File
  177. ----
  178.  
  179. Open Diary     - Displays an item  selector  box for the  user  to enter a
  180.                  filename. If a file is already  open then the  user  will
  181.                  be asked for confirmation  to clear  this  old  file from
  182.                  main memory (RAM).
  183.  
  184.                  If the filename (less extension) matches the current year 
  185.                  (held  by the system clock) then the year will be  opened
  186.                  in the normal manner and the current  day  in  the  diary
  187.                  will be displayed. If the system clock year doesn't match
  188.                  the filename then the 1st of January for that  year  will
  189.                  be displayed.
  190.  
  191.                  If the filename doesn't match a year then the  user  will 
  192.                  be asked to select an appropriate year for the file.  See 
  193.                  'Create  Year'  for limitations  on  years  that  can  be 
  194.                  selected.
  195.  
  196.                  [ Short cut Key - F1 ]
  197.  
  198. Save Diary     - Displays  an item selector  box for the  user to  enter a
  199.                  filename to save the current year. Note the file selector 
  200.                  will default to  the  current  year (set  by  the  CREATE 
  201.                  command) plus the extension .DRY, it is recommended  that
  202.                  the user selects this option.
  203.  
  204.                  Example : 1992.DRY
  205.  
  206.                  Different file extensions to '.DRY' may be used  but  the 
  207.                  year part of the filename is used by the OPEN command, so 
  208.                  it must remain the same as the year the file contains.
  209.  
  210.                  [ Short cut Key - F2 ]
  211.  
  212. Create Diary   - Displays a box with the  current  yea